Vcenter Topology ReplicationStatus Summary

Vcenter Topology ReplicationStatus Summary

The Vcenter Topology ReplicationStatus Summary schema contains replication information of partner vCenter or Platform Services Controller node of type VCSA_EMBEDDED/PSC_EXTERNAL (see Vcenter Topology Nodes Info.type).

This schema was added in vSphere API 6.7.2.

JSON Example

{
    "node": "string",
    "replication_partner": "string",
    "partner_available": false,
    "status_available": false,
    "replicating": false,
    "change_lag": 0
}

string

node

Required

Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node.

This property was added in vSphere API 6.7.2.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

string

replication_partner

Required

Identifier for the vCenter or Platform Services Controller replication partner. Identifier can be either IP address or DNS resolvable name of the replication partner.

This property was added in vSphere API 6.7.2.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

boolean

partner_available

Required

Indicates if the VMware Directory Service on partner is reachable or not.

This property was added in vSphere API 6.7.2.

boolean

status_available

Required

Indicates if the replication status for the node with respect to replication partner can be retrieved or not.

This property was added in vSphere API 6.7.2.

boolean

replicating

Optional

Indicates if node is processing replication changes from the replication partner.

This property was added in vSphere API 6.7.2.

This property will be missing or null if the partner host or replication status is not available, i.e, if Vcenter Topology ReplicationStatus Summary.partner_available or Vcenter Topology ReplicationStatus Summary.status_available is false.

integer As int64 As int64

change_lag

Optional

Number of replication changes node is behind the replication partner.

This property was added in vSphere API 6.7.2.

This property will be missing or null if the partner host or replication status is not available, i.e, if Vcenter Topology ReplicationStatus Summary.partner_available or Vcenter Topology ReplicationStatus Summary.status_available is false.